<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSymbolicColor: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
<link rel="prev" href="DeprecatedObjects.html" title="Deprecated">
<link rel="next" href="gtk3-GtkGradient.html" title="GtkGradient">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gtk3-GtkSymbolicColor.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="DeprecatedObjects.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gtk3-GtkGradient.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gtk3-GtkSymbolicColor"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk3-GtkSymbolicColor.top_of_page"></a>GtkSymbolicColor</span></h2>
<p>GtkSymbolicColor — Symbolic colors</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gtk3-GtkSymbolicColor.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-new-literal" title="gtk_symbolic_color_new_literal ()">gtk_symbolic_color_new_literal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-new-name" title="gtk_symbolic_color_new_name ()">gtk_symbolic_color_new_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-new-shade" title="gtk_symbolic_color_new_shade ()">gtk_symbolic_color_new_shade</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-new-alpha" title="gtk_symbolic_color_new_alpha ()">gtk_symbolic_color_new_alpha</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-new-mix" title="gtk_symbolic_color_new_mix ()">gtk_symbolic_color_new_mix</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-new-win32" title="gtk_symbolic_color_new_win32 ()">gtk_symbolic_color_new_win32</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-ref" title="gtk_symbolic_color_ref ()">gtk_symbolic_color_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-unref" title="gtk_symbolic_color_unref ()">gtk_symbolic_color_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-resolve" title="gtk_symbolic_color_resolve ()">gtk_symbolic_color_resolve</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-to-string" title="gtk_symbolic_color_to_string ()">gtk_symbolic_color_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtk3-GtkSymbolicColor.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor">GtkSymbolicColor</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtk3-GtkSymbolicColor.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="gtk3-GtkSymbolicColor.description"></a><h2>Description</h2>
<p>GtkSymbolicColor is a boxed type that represents a symbolic color.
It is the result of parsing a
color expression.
To obtain the color represented by a GtkSymbolicColor, it has to
be resolved with <a class="link" href="gtk3-GtkSymbolicColor.html#gtk-symbolic-color-resolve" title="gtk_symbolic_color_resolve ()"><code class="function">gtk_symbolic_color_resolve()</code></a>, which replaces all
symbolic color references by the colors they refer to (in a given
context) and evaluates mix, shade and other expressions, resulting
in a <span class="type">GdkRGBA</span> value.</p>
<p>It is not normally necessary to deal directly with <a href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor"><span class="type">GtkSymbolicColors</span></a>,
since they are mostly used behind the scenes by <a class="link" href="GtkStyleContext.html" title="GtkStyleContext"><span class="type">GtkStyleContext</span></a> and
<a class="link" href="GtkCssProvider.html" title="GtkCssProvider"><span class="type">GtkCssProvider</span></a>.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated. Symbolic colors are considered an
implementation detail of GTK+.</p>
</div>
<div class="refsect1">
<a name="gtk3-GtkSymbolicColor.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-symbolic-color-new-literal"></a><h3>gtk_symbolic_color_new_literal ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
gtk_symbolic_color_new_literal (<em class="parameter"><code>const <span class="type">GdkRGBA</span> *color</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_new_literal</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Creates a symbolic color pointing to a literal color.</p>
<div class="refsect3">
<a name="gtk-symbolic-color-new-literal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>a <span class="type">GdkRGBA</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-new-literal.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-new-name"></a><h3>gtk_symbolic_color_new_name ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
gtk_symbolic_color_new_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_new_name</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Creates a symbolic color pointing to an unresolved named
color. See <a class="link" href="GtkStyleContext.html#gtk-style-context-lookup-color" title="gtk_style_context_lookup_color ()"><code class="function">gtk_style_context_lookup_color()</code></a> and
<a class="link" href="gtk3-GtkStyleProperties.html#gtk-style-properties-lookup-color" title="gtk_style_properties_lookup_color ()"><code class="function">gtk_style_properties_lookup_color()</code></a>.</p>
<div class="refsect3">
<a name="gtk-symbolic-color-new-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>color name</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-new-name.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-new-shade"></a><h3>gtk_symbolic_color_new_shade ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
gtk_symbolic_color_new_shade (<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color</code></em>,
                              <em class="parameter"><code><span class="type">gdouble</span> factor</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_new_shade</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Creates a symbolic color defined as a shade of
another color. A factor &gt; 1.0 would resolve to
a brighter color, while &lt; 1.0 would resolve to
a darker color.</p>
<p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p>
<div class="refsect3">
<a name="gtk-symbolic-color-new-shade.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>another <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>factor</p></td>
<td class="parameter_description"><p>shading factor to apply to <em class="parameter"><code>color</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-new-shade.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-new-alpha"></a><h3>gtk_symbolic_color_new_alpha ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
gtk_symbolic_color_new_alpha (<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color</code></em>,
                              <em class="parameter"><code><span class="type">gdouble</span> factor</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_new_alpha</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Creates a symbolic color by modifying the relative alpha
value of <em class="parameter"><code>color</code></em>
. A factor &lt; 1.0 would resolve to a more
transparent color, while &gt; 1.0 would resolve to a more
opaque color.</p>
<p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p>
<div class="refsect3">
<a name="gtk-symbolic-color-new-alpha.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>another <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>factor</p></td>
<td class="parameter_description"><p>factor to apply to <em class="parameter"><code>color</code></em>
alpha</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-new-alpha.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-new-mix"></a><h3>gtk_symbolic_color_new_mix ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
gtk_symbolic_color_new_mix (<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color1</code></em>,
                            <em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color2</code></em>,
                            <em class="parameter"><code><span class="type">gdouble</span> factor</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_new_mix</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Creates a symbolic color defined as a mix of another
two colors. a mix factor of 0 would resolve to <em class="parameter"><code>color1</code></em>
,
while a factor of 1 would resolve to <em class="parameter"><code>color2</code></em>
.</p>
<p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p>
<div class="refsect3">
<a name="gtk-symbolic-color-new-mix.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>color1</p></td>
<td class="parameter_description"><p>color to mix</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color2</p></td>
<td class="parameter_description"><p>another color to mix</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>factor</p></td>
<td class="parameter_description"><p>mix factor</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-new-mix.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-new-win32"></a><h3>gtk_symbolic_color_new_win32 ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
gtk_symbolic_color_new_win32 (<em class="parameter"><code>const <span class="type">gchar</span> *theme_class</code></em>,
                              <em class="parameter"><code><span class="type">gint</span> id</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_new_win32</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Creates a symbolic color based on the current win32
theme.</p>
<p>Note that while this call is available on all platforms
the actual value returned is not reliable on non-win32
platforms.</p>
<p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p>
<div class="refsect3">
<a name="gtk-symbolic-color-new-win32.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>theme_class</p></td>
<td class="parameter_description"><p>The theme class to pull color from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>The color id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-new-win32.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-ref"></a><h3>gtk_symbolic_color_ref ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="returnvalue">GtkSymbolicColor</span></a> *
gtk_symbolic_color_ref (<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_ref</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Increases the reference count of <em class="parameter"><code>color</code></em>
</p>
<div class="refsect3">
<a name="gtk-symbolic-color-ref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-ref.returns"></a><h4>Returns</h4>
<p> the same <em class="parameter"><code>color</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-unref"></a><h3>gtk_symbolic_color_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_symbolic_color_unref (<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_unref</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Decreases the reference count of <em class="parameter"><code>color</code></em>
, freeing its memory if the
reference count reaches 0.</p>
<div class="refsect3">
<a name="gtk-symbolic-color-unref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-resolve"></a><h3>gtk_symbolic_color_resolve ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_symbolic_color_resolve (<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color</code></em>,
                            <em class="parameter"><code><a class="link" href="gtk3-GtkStyleProperties.html#GtkStyleProperties" title="struct GtkStyleProperties"><span class="type">GtkStyleProperties</span></a> *props</code></em>,
                            <em class="parameter"><code><span class="type">GdkRGBA</span> *resolved_color</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_resolve</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>If <em class="parameter"><code>color</code></em>
 is resolvable, <em class="parameter"><code>resolved_color</code></em>
 will be filled in
with the resolved color, and <code class="literal">TRUE</code> will be returned. Generally,
if <em class="parameter"><code>color</code></em>
 can’t be resolved, it is due to it being defined on
top of a named color that doesn’t exist in <em class="parameter"><code>props</code></em>
.</p>
<p>When <em class="parameter"><code>props</code></em>
 is <code class="literal">NULL</code>, resolving of named colors will fail, so if
your <em class="parameter"><code>color</code></em>
 is or references such a color, this function will
return <code class="literal">FALSE</code>.</p>
<div class="refsect3">
<a name="gtk-symbolic-color-resolve.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>props</p></td>
<td class="parameter_description"><p><a class="link" href="gtk3-GtkStyleProperties.html#GtkStyleProperties" title="struct GtkStyleProperties"><span class="type">GtkStyleProperties</span></a> to use when resolving
named colors, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>resolved_color</p></td>
<td class="parameter_description"><p>return location for the resolved color. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-resolve.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the color has been resolved</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-symbolic-color-to-string"></a><h3>gtk_symbolic_color_to_string ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
gtk_symbolic_color_to_string (<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_symbolic_color_to_string</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> is deprecated.</p>
</div>
<p>Converts the given <em class="parameter"><code>color</code></em>
 to a string representation. This is useful
both for debugging and for serialization of strings. The format of
the string may change between different versions of GTK, but it is
guaranteed that the GTK css parser is able to read the string and
create the same symbolic color from it.</p>
<div class="refsect3">
<a name="gtk-symbolic-color-to-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>color to convert to a string</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-symbolic-color-to-string.returns"></a><h4>Returns</h4>
<p> a new string representing <em class="parameter"><code>color</code></em>
</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gtk3-GtkSymbolicColor.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSymbolicColor"></a><h3>GtkSymbolicColor</h3>
<pre class="programlisting">typedef struct _GtkSymbolicColor GtkSymbolicColor;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>